EfImageFormatter

class EfImageFormatter extends EfFieldFormatter

Provides formatting methods for image field types.

Methods

__construct(EntityMetadataWrapper $property, bool $isMultivalue)

Constructor.

from EfFieldFormatter
array|string
value()

Returns the current field item as a raw array.

from EfFieldFormatter
array
values()

Returns all raw field items in an array.

from EfFieldFormatter
EfFieldFormatter[]
all()

Returns an array of all field items as EfFieldFormatter objects.

from EfFieldFormatter
array
setDelta($delta)

Set the current field delta.

from EfFieldFormatter
bool
isDeltaValid(null $delta = NULL)

Checks if the given or current field delta exists.

from EfFieldFormatter
bool
notEmpty()

Shortcut for the possible not so easy to understand isDeltaValid() method.

from EfFieldFormatter
bool
isAccessible()

Check if current user is allowed to view this field.

from EfFieldFormatter
EfFieldFormatterIterator
getIterator()

Implementing IteratorAggregate interface.

from EfFieldFormatter
int
count()

Implementing Countable interface.

from EfFieldFormatter
$this
setImageStyle($imageStyle)

Set the image style which is used when printing this image.

string
src()

Returns the URL for this image.

mixed|string
relativePath()

Returns the relative path including query (itok).

string
img()

Returns an tag for this image.

string
alt()

Returns the alt attribute for this image.

string
title()

Returns the title attribute for this image.

string
width()

Returns the width for this image.

string
height()

Returns the height for this image.

__toString()

No description

Details

in EfFieldFormatter at line 23
__construct(EntityMetadataWrapper $property, bool $isMultivalue)

Constructor.

Parameters

EntityMetadataWrapper $property The value of this field wrapped by an EntityMetadataWrapper.
bool $isMultivalue Whether this field has a cardinality greater than one.

in EfFieldFormatter at line 43
array|string value()

Returns the current field item as a raw array.

Return Value

array|string

in EfFieldFormatter at line 52
array values()

Returns all raw field items in an array.

Return Value

array

in EfFieldFormatter at line 61
EfFieldFormatter[] all()

Returns an array of all field items as EfFieldFormatter objects.

Return Value

EfFieldFormatter[]

in EfFieldFormatter at line 74
array setDelta($delta)

Set the current field delta.

Parameters

$delta

Return Value

array

in EfFieldFormatter at line 91
bool isDeltaValid(null $delta = NULL)

Checks if the given or current field delta exists.

Parameters

null $delta

Return Value

bool

in EfFieldFormatter at line 102
bool notEmpty()

Shortcut for the possible not so easy to understand isDeltaValid() method.

Return Value

bool

in EfFieldFormatter at line 113
bool isAccessible()

Check if current user is allowed to view this field.

Can be needed if a module like field_permissions is in use.

Return Value

bool True, if current user is allowed to view this field.

in EfFieldFormatter at line 124
EfFieldFormatterIterator getIterator()

Implementing IteratorAggregate interface.

If we wrap a list, we return an iterator over the data list.

Return Value

EfFieldFormatterIterator

in EfFieldFormatter at line 133
int count()

Implementing Countable interface.

Return Value

int The number of items of this field.

at line 317
$this setImageStyle($imageStyle)

Set the image style which is used when printing this image.

Parameters

$imageStyle

Return Value

$this

at line 327
string src()

Returns the URL for this image.

Return Value

string

at line 345
mixed|string relativePath()

Returns the relative path including query (itok).

Return Value

mixed|string

at line 365
string img()

Returns an tag for this image.

Return Value

string

at line 390
string alt()

Returns the alt attribute for this image.

Return Value

string

at line 404
string title()

Returns the title attribute for this image.

Return Value

string

at line 418
string width()

Returns the width for this image.

Return Value

string

at line 444
string height()

Returns the height for this image.

Return Value

string

at line 465
__toString()